Skip to main content

NGIAB End-to-End Setup Guide

Overview​

This guide provides step-by-step instructions for setting up and running the complete NGIAB workflow, including data preprocessor, model execution, TEEHR evaluation and Tethys visualization.

Prerequisites​

  • Python 3.x
  • Git
  • Docker
  • Terminal access

Video Tutorial​

Quick Start Guide (5 minutes)​

You can watch our step-by-step video guide here:

Video Contents Timeline​

(System: Using Mac M1 Max Laptop)

  • 0:00 - Introduction
  • 0:10 - Data Preprocessing Setup
  • 2:32 - NGIAB Installation
  • 3:05 - Running TEEHR Evaluation
  • 4:30 - Visualization using Tethys Portal
  • 5:05 - Verify Output Plot and Conclusion

Step 1: Data Preprocessing​

Clone and Configure Data Preprocess​

# Clone the repository
git clone https://github.com/CIROH-UA/NGIAB_data_preprocess

# Navigate to project directory
cd NGIAB_data_preprocess

# Create and activate virtual environment
python3 -m venv .venv
source .venv/bin/activate

# Install required package
pip install 'ngiab_data_preprocess'

Run Data Preprocess​

# Execute preprocess for sample catchment
python -m ngiab_data_cli -i cat-2863657 --subset --start 2010-01-01 --end 2010-01-02 --forcings --realization

Parameters Explained​

ParameterDescription
-i cat-2863657Specifies the catchment ID
--subsetCreates a subset of the data
--startStart date for the analysis
--endEnd date for the analysis
--forcingsIncludes forcing data
--realizationGenerates realization data

Step 2: NGIAB Setup and Execution​

Clone and Run NGIAB​

# Return to home directory
cd ..

# Clone NGIAB repository
git clone https://github.com/CIROH-UA/NGIAB-CloudInfra.git

# Navigate to NGIAB directory
cd NGIAB-CloudInfra

# Execute the setup and run script
./guide.sh

Automated Process​

The guide.sh script automatically:

  • Sets up the NGIAB environment
  • Launches the NextGen model
  • Initializes and run TEEHR analysis tools
  • Starts the visualization interface

Accessing the Tools​

After successful execution, you can access:

  • Visualizer: http://localhost/apps/ngiab

Troubleshooting​

Common issues and solutions:

  1. Docker Issues

    • Ensure Docker is running
    • Verify Docker configuration
    • Check Docker permissions

  2. Virtual Environment

    • Confirm activation status
    • Check Python version compatibility

  3. Installation Problems

    • Verify prerequisites
    • Check system requirements
    • Review error logs

Additional Resources​

Documentation​

Support​

For technical support:

  • Create an issue in the respective GitHub repository
  • Contact CIROH support team
  • Join community discussions on CIROH Slack